Name of this file: Install Personal Config and Definition Files - README.txt
		   (reference HEC-ResSim, Version 4.0)


Question: What is "Install Personal Config and Definition Files.hta" used for?

Answer: It is an HTML script designed to copy files into an editable area for 
	  HEC-ResSim so that you can make changes to the default settings without
	  needing Administrator rights.

          Below are instructions on how to use the script.

          1) Double click on the file named 
	  	  Install Personal Config and Definition Files.hta
	     located in the folder you opened this README from.

          2) The script will open up a Window displaying information about what 
	     the script is doing.

          3) In this window, make note of where and what files are being copied.

          4) A Windows Explorer window will be opened where the copied files have
	     been placed.

          5) Modify the Personal config file and the two definition files per 
	     your requirements.


Question: What changes can I make in these files and Why?

Answer 1: HEC-ResSim - Personal.config

          There are two options you can change in the config file. If you make 
	  any changes to this file, you must restart HEC-ResSim to apply them.

	  1) Maximum memory: 
		By default HEC-ResSim is configured to use a maximum memory of 
		4000MB. This Personal .config file allows you to change this
		value depending on your need and you available RAM.  The default
		setting in the Personal config file is 6000MB, but you can modify that.
		The allowable range for the memory setting is dependent on your system configuration.
		If HEC-Ressim will not start, try a smaller value.
		
	  2) Display Parameters:
		Some display (video) drivers have compatibility issues with Java.
		If you experience flickering, redraw delays, or other display 
		issues, uncomment the Display Parameters line in the Personal 
		config file.  These parameter settings should resolve most display
		issues.  If you continue to experience problems, please see the
		HEC-ResSim Bug Report page of our website or for USACE, report via
		https://discourse.hecdev.net/c/hec-ressim/rss-bug-report/47.

Answer 2: parameters_units.def

	  This file contains a list of the data parameter types known by ResSim
	  and each parameter's default units.  If you have data that represents 
	  a parameter that is not listed you can add that parameter to this file.
	  Or, if you want to change the default units of an existing parameter, 
	  you can do so with this file.  For example, the example watershed: 
	  BaldEagle_v4.0 includes a "user report" that calculates volume.  When 
	  we plotted the resultant data, the units were cubic feet.  Since our
	  report's computations calculated acre-ft, we changed the default units
	  in the parameter_units.def file used by HEC-ResSim.

Answer 3: unitConversions.def
 
          This file has two sections:

	  1) The first section is a list of acceptable units and unit aliases for 
	  most common forms of measure (length, area, volume, time, rate, etc). 
	  If you have data that is stored in DSS in units that are not listed in
	  this file, you can add your data's units and or unit alias to this
	  section.
	  
	  For example, we had an evaporation time-series with units of INCHES. 
	  When we used this data in HEC-ResSim, the units were not recognized and
	  ResSim mishandled the data. In trying to fix the problem we discovered
	  that the unitConversions.def file did not have "INCHES" as an acceptable
	  alias for "inches" (yes, it is case-sensitive).  So, we added INCHES 
	  and IN to the acceptable aliases for the length unit "inches".  
	  At that time, we reviewed all other units and aliases listed, adding 
	  several aliases for standard units in upper-case text that had been 
	  forgotten; that doesn't mean we've covered all possibilities, so this 
	  file has been provided "just-in-case".

	  2) The second part lists the factor to be used for unit conversion for
	  base unit to another base unit.  For example, the factor to convert
	  English feet (ft) to English inches (in) is 12 and the factor to convert
	  English feet (ft) to Metric (SI) meters (m) is 0.3048.
	  If you find a need to add a new unit to the list of acceptable units in 
	  the first section (not just an new alias), then you should add a
	  conversion factor from one of the other units to your new unit.  
	  
	  For example, if you added the following line to the Volume Rate units: 
	      SI; kcms;KCMS;1000 cms; 1000 m3/sec;1000 cu-meters/sec;1000 M3/SEC

	  Then you should also add this line to the Volume Rate Conversions:
	      SI; kcms>SI;cms;1000

   NOTE - If you need to make revisions to "parameters_units.def" or
          "unitConversions.def",then it's possible there are other users that
	  would also benefit from that change or addition.  Therefore, if you 
	  think your revisions would be appropriate for future versions of ResSim,
	  then let us know by sending us an email with the specific information to: 
          hec.ressim@usace.army.mil

